Public Member Functions | Protected Member Functions | Protected Attributes

vfsStreamAbstractContent Class Reference

Inheritance diagram for vfsStreamAbstractContent:
vfsStreamContent vfsStreamDirectory vfsStreamFile

Public Member Functions

 __construct ($name, $permissions=null)
 getName ()
 rename ($newName)
 appliesTo ($name)
 getType ()
 setFilemtime ($filemtime)
 lastModified ($filemtime)
 filemtime ()
 at (vfsStreamContainer $container)
 chmod ($permissions)
 getPermissions ()
 isReadable ($user, $group)
 isWritable ($user, $group)
 isExecutable ($user, $group)
 chown ($user)
 isOwnedByUser ($user)
 getUser ()
 chgrp ($group)
 isOwnedByGroup ($group)
 getGroup ()

Protected Member Functions

 getDefaultPermissions ()

Protected Attributes

 $name
 $type
 $lastModified
 $permissions
 $user
 $group

Constructor & Destructor Documentation

__construct ( name,
permissions = null 
)

constructor

Parameters:
string$name
int$permissionsoptional

Reimplemented in vfsStreamDirectory, and vfsStreamFile.


Member Function Documentation

appliesTo ( name )

checks whether the container can be applied to given name

Parameters:
string$name
Returns:
bool

Implements vfsStreamContent.

Reimplemented in vfsStreamFile.

at ( vfsStreamContainer container )

adds content to given container

Parameters:
vfsStreamContainer$container
Returns:
vfsStreamContent

Implements vfsStreamContent.

chgrp ( group )

change owner group of file to given group

Parameters:
int$group
Returns:
vfsStreamContent

Implements vfsStreamContent.

chmod ( permissions )

change file mode to given permissions

Parameters:
int$permissions
Returns:
vfsStreamContent

Implements vfsStreamContent.

chown ( user )

change owner of file to given user

Parameters:
int$user
Returns:
vfsStreamContent

Implements vfsStreamContent.

filemtime (  )

returns the last modification time of the stream content

Returns:
int

Implements vfsStreamContent.

getDefaultPermissions (  ) [abstract, protected]

returns default permissions for concrete implementation

Returns:
int
Since:
0.8.0

Reimplemented in vfsStreamDirectory, and vfsStreamFile.

getGroup (  )

returns owner group of file

Returns:
int

Implements vfsStreamContent.

getName (  )

returns the file name of the content

Returns:
string

Implements vfsStreamContent.

getPermissions (  )

returns permissions

Returns:
int

Implements vfsStreamContent.

getType (  )

returns the type of the container

Returns:
int

Implements vfsStreamContent.

getUser (  )

returns owner of file

Returns:
int

Implements vfsStreamContent.

isExecutable ( user,
group 
)

checks whether content is executable

Parameters:
int$userid of user to check for
int$groupid of group to check for
Returns:
bool

Implements vfsStreamContent.

isOwnedByGroup ( group )

checks whether file is owned by group

Parameters:
int$group
Returns:
bool

Implements vfsStreamContent.

isOwnedByUser ( user )

checks whether file is owned by given user

Parameters:
int$user
Returns:
bool

Implements vfsStreamContent.

isReadable ( user,
group 
)

checks whether content is readable

Parameters:
int$userid of user to check for
int$groupid of group to check for
Returns:
bool

Implements vfsStreamContent.

isWritable ( user,
group 
)

checks whether content is writable

Parameters:
int$userid of user to check for
int$groupid of group to check for
Returns:
bool

Implements vfsStreamContent.

lastModified ( filemtime )

sets the last modification time of the stream content

Parameters:
int$filemtime
Returns:
vfsStreamContent

Implements vfsStreamContent.

rename ( newName )

renames the content

Parameters:
string$newName

Implements vfsStreamContent.

Reimplemented in vfsStreamDirectory.

setFilemtime ( filemtime )

alias for lastModified()

Parameters:
int$filemtime
Returns:
vfsStreamContent
See also:
lastModified()

Implements vfsStreamContent.


The documentation for this class was generated from the following file: